<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  <title>gespeaker dbus interface - /org/gtk/gespeaker/voice</title>
  <link rel="stylesheet" href="style.css" type="text/css">
  <link rel="start" href="index.html" title="Gespeaker DBus API Reference Manual">
  <link rel="up" href="interfaces.html" title="Available Interfaces">
  <link rel="prev" href="org.gtk.gespeaker.espeak.html" title="/org/gtk/gespeaker/espeak">
  <link rel="next" href="examples.html" title="Examples">
</head>
<body link="#0000ff" alink="#0000ff" bgcolor="white" text="black" vlink="#840084">
  <div>
    <!-- header -->
    <table class="table_title">
      <tbody>
        <tr>
          <th colspan="3" align="center">org.gtk.gespeaker</th>
        </tr>
        <tr>
          <td align="left" width="20%"><a href="org.gtk.gespeaker.espeak.html">Prev</a>&nbsp;</td>
          <th align="center" width="60%">gespeaker dbus interfaces</th>
          <td align="right" width="20%">&nbsp;<a href="examples.html">Next</a></td>
        </tr>
      </tbody>
    </table>
    <hr>
    <!-- end of header -->

    <div>
      <h2>Interface /org/gtk/gespeaker/voice</h2>
      <p>Manage the espeak and mbrola voices.<br></p>
    </div>

    <div>
      <h2>Methods</h2>
      <table class="methods"><tbody class="method_definition"><tr><td>
            int <a href="#get_delay">org.gtk.gespeaker.voice.int.get_delay</a>()
            int <a href="#get_pitch">org.gtk.gespeaker.voice.int.get_pitch</a>()
            int <a href="#get_speed">org.gtk.gespeaker.voice.int.get_speed</a>()
            int <a href="#get_voice">org.gtk.gespeaker.voice.int.get_voice</a>()
           bool <a href="#get_voice_is_mbrola">org.gtk.gespeaker.voice.get_voice_is_mbrola</a>(<span class="parameter">int index</span>)
        QString <a href="#get_voice_name">org.gtk.gespeaker.voice.get_voice_name</a>(<span class="parameter">int index</span>)
        QString <a href="#get_voice_short">org.gtk.gespeaker.voice.get_voice_short</a>(<span class="parameter">int index</span>)
        QString <a href="#get_voice_type">org.gtk.gespeaker.voice.get_voice_type</a>()
            int <a href="#get_voices_count">org.gtk.gespeaker.voice.get_voices_count</a>()
            int <a href="#get_volume">org.gtk.gespeaker.voice.get_volume</a>()
    QStringList <a href="#list_all_voices">org.gtk.gespeaker.voice.list_all_voices</a>()
    QStringList <a href="#list_mbrola_voices">org.gtk.gespeaker.voice.list_mbrola_voices</a>()
           bool <a href="#set_delay">org.gtk.gespeaker.voice.set_delay</a>(<span class="parameter">int delay</span>)
           bool <a href="#set_pitch">org.gtk.gespeaker.voice.set_pitch</a>(<span class="parameter">int pitch</span>)
           bool <a href="#set_speed">org.gtk.gespeaker.voice.set_speed</a>(<span class="parameter">int speed</span>)
           bool <a href="#set_voice">org.gtk.gespeaker.voice.set_voice</a>(<span class="parameter">int voice</span>)
           bool <a href="#set_voice_by_name">org.gtk.gespeaker.voice.set_voice_by_name</a>(<span class="parameter">QString name</span>)
           bool <a href="#set_voice_type">org.gtk.gespeaker.voice.set_voice_type</a>(<span class="parameter">QString voice_type</span>)
           bool <a href="#set_volume">org.gtk.gespeaker.voice.set_volume</a>(<span class="parameter">int volume</span>)
      </td></tr></tbody></table>
    </div>
  </div>
  <hr>

  <div>
    <a name="get_delay"></a>
    <h3>org.gtk.gespeaker.voice.get_delay</h3>
    <p class="method_definition">int org.gtk.gespeaker.voice.get_delay()</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td>An integer for the current voice delay</td>
      </tr>
    </tbody></table>
    The <span class="method_name">get_delay</span> method returns the voice delay between words. 
  </div>

  <div>
    <a name="get_pitch"></a>
    <h3>org.gtk.gespeaker.voice.get_pitch</h3>
    <p class="method_definition">int org.gtk.gespeaker.voice.get_pitch()</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td>An integer for the current pitch</td>
      </tr>
    </tbody></table>
    The <span class="method_name">get_pitch</span> method returns the voice pitch. 
  </div>

  <div>
    <a name="get_speed"></a>
    <h3>org.gtk.gespeaker.voice.get_speed</h3>
    <p class="method_definition">int org.gtk.gespeaker.voice.get_speed()</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td>An integer for the current voice speed</td>
      </tr>
    </tbody></table>
    The <span class="method_name">get_speed</span> method returns the voice speed. 
  </div>

  <div>
    <a name="get_voice"></a>
    <h3>org.gtk.gespeaker.voice.get_voice</h3>
    <p class="method_definition">int org.gtk.gespeaker.voice.get_voice()</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td>An integer for the index of the currently selected voice</td>
      </tr>
    </tbody></table>
    The <span class="method_name">get_voice</span> method returns an index for the currently selected voice.
  </div>

  <div>
    <a name="get_voice_is_mbrola"></a>
    <h3>org.gtk.gespeaker.voice.get_voice_is_mbrola</h3>
    <p class="method_definition">bool org.gtk.gespeaker.voice.get_voice_is_mbrola(<span class="parameter">int index</span>)</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">index:</td>
        <td>The index of the voice to check</td>
      </tr>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td><span class="fixed">True</span> if the voice is a mbrola voice, <span class="fixed">False</span> if the voice is not mbrola or is not a valid voice index.</td>
      </tr>
    </tbody></table>
    The <span class="method_name">get_voice_is_mbrola</span> method check if the requested voice is a mbrola voice. 
  </div>

  <div>
    <a name="get_voice_name"></a>
    <h3>org.gtk.gespeaker.voice.get_voice_name</h3>
    <p class="method_definition">QString org.gtk.gespeaker.voice.get_voice_name(<span class="parameter">int index</span>)</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">index:</td>
        <td>The index of the voice to check</td>
      </tr>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td>A string for the voice name</td>
      </tr>
    </tbody></table>
    The <span class="method_name">get_voice_name</span> method return the name of the requested voice. 
  </div>

  <div>
    <a name="get_voice_short"></a>
    <h3>org.gtk.gespeaker.voice.get_voice_short</h3>
    <p class="method_definition">QString org.gtk.gespeaker.voice.get_voice_short(<span class="parameter">int index</span>)</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">index:</td>
        <td>The index of the voice to check</td>
      </tr>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td>A string for the voice short name</td>
      </tr>
    </tbody></table>
    The <span class="method_name">get_voice_short</span> method return the short name of the requested voice. 
  </div>

  <div>
    <a name="get_voice_type"></a>
    <h3>org.gtk.gespeaker.voice.get_voice_type</h3>
    <p class="method_definition">QString org.gtk.gespeaker.voice.get_voice_type()</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td>A string as following: <span class="fixed">disabled</span> for mbrola voices which doesn't support type, <span class="fixed">male</span> for non-mbrola male voice, <span class="fixed">female</span> for non-mbrola female voice</td>
      </tr>
    </tbody></table>
    The <span class="method_name">get_voice_type</span> method return the type of the selected voice. 
  </div>

  <div>
    <a name="get_voices_count"></a>
    <h3>org.gtk.gespeaker.voice.get_voices_count</h3>
    <p class="method_definition">int org.gtk.gespeaker.voice.get_voices_count()</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td>The number of the available voices</td>
      </tr>
    </tbody></table>
    The <span class="method_name">get_voices_count</span> method returns the number of the available voices. 
  </div>

  <div>
    <a name="get_volume"></a>
    <h3>org.gtk.gespeaker.voice.get_volume</h3>
    <p class="method_definition">int org.gtk.gespeaker.voice.get_volume()</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td>An integer for the current volume</td>
      </tr>
    </tbody></table>
    The <span class="method_name">get_volume</span> method returns the current volume. 
  </div>

  <div>
    <a name="list_all_voices"></a>
    <h3>org.gtk.gespeaker.voice.list_all_voices</h3>
    <p class="method_definition">QStringList org.gtk.gespeaker.voice.list_all_voices()</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td>A string list with all the available voices</td>
      </tr>
    </tbody></table>
    The <span class="method_name">list_all_voices</span> method returns the list with all the available voice names. 
  </div>

  <div>
    <a name="list_mbrola_voices"></a>
    <h3>org.gtk.gespeaker.voice.list_mbrola_voices</h3>
    <p class="method_definition">QStringList org.gtk.gespeaker.voice.list_mbrola_voices()</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td>A string list with all the available mbrola voices</td>
      </tr>
    </tbody></table>
    The <span class="method_name">list_mbrola_voices</span> method returns the list with all the available mbrola voice names. 
  </div>

  <div>
    <a name="set_delay"></a>
    <h3>org.gtk.gespeaker.voice.set_delay</h3>
    <p class="method_definition">bool org.gtk.gespeaker.voice.set_delay(<span class="parameter">int delay</span>)</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">delay:</td>
        <td>The new delay to assign</td>
      </tr>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td><span class="fixed">True</span> if the delay was assigned or <span class="fixed">False</span> if it wasn't assigned</td>
      </tr>
    </tbody></table>
    The <span class="method_name">set_delay</span> method assign the new value for delay between words. Valid values are between 0 and 100. 
  </div>

  <div>
    <a name="set_pitch"></a>
    <h3>org.gtk.gespeaker.voice.set_pitch</h3>
    <p class="method_definition">bool org.gtk.gespeaker.voice.set_pitch(<span class="parameter">int pitch</span>)</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">pitch:</td>
        <td>The new pitch to assign</td>
      </tr>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td><span class="fixed">True</span> if the pitch was assigned or <span class="fixed">False</span> if it wasn't assigned</td>
      </tr>
    </tbody></table>
    The <span class="method_name">set_pitch</span> method assign the new value for voice pitch. Valid values are between 0 and 99. 
  </div>

  <div>
    <a name="set_speed"></a>
    <h3>org.gtk.gespeaker.voice.set_speed</h3>
    <p class="method_definition">bool org.gtk.gespeaker.voice.set_speed(<span class="parameter">int speed</span>)</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">speed:</td>
        <td>The new delay to assign</td>
      </tr>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td><span class="fixed">True</span> if the delay was assigned or <span class="fixed">False</span> if it wasn't assigned</td>
      </tr>
    </tbody></table>
    The <span class="method_name">set_speed</span> method assign the new value for voice speed. Valid values are between 80 and 390. 
  </div>

  <div>
    <a name="set_voice"></a>
    <h3>org.gtk.gespeaker.voice.set_voice</h3>
    <p class="method_definition">bool org.gtk.gespeaker.voice.set_voice(<span class="parameter">int voice</span>)</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">voice:</td>
        <td>Index of the new voice to choose</td>
      </tr>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td><span class="fixed">True</span> if the voice was chosen or <span class="fixed">False</span> if it wasn't chosen</td>
      </tr>
    </tbody></table>
    The <span class="method_name">set_voice</span> method changes the active voice using a voice index. Valid values are between 0 and the value returned by <span class="method_name">org.gtk.gespeaker.voice.get_voices_count()</span> method. 
  </div>

  <div>
    <a name="set_voice_by_name"></a>
    <h3>org.gtk.gespeaker.voice.set_voice_by_name</h3>
    <p class="method_definition">bool org.gtk.gespeaker.voice.set_voice_by_name(<span class="parameter">QString voice</span>)</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">voice:</td>
        <td>A string with the name of the new voice to choose</td>
      </tr>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td><span class="fixed">True</span> if the voice was chosen or <span class="fixed">False</span> if it wasn't chosen</td>
      </tr>
    </tbody></table>
    The <span class="method_name">set_voice_by_name</span> method changes the active voice using a voice name. 
  </div>

  <div>
    <a name="set_voice_type"></a>
    <h3>org.gtk.gespeaker.voice.set_voice_type</h3>
    <p class="method_definition">bool org.gtk.gespeaker.voice.set_voice_type(<span class="parameter">QString voice_type</span>)</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">voice_type:</td>
        <td>A string with the voice type: it must be <span class="fixed">male</span> or <span class="fixed">female</span></td>
      </tr>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td><span class="fixed">True</span> if the voice type was chosen or <span class="fixed">False</span> if it wasn't chosen</td>
      </tr>
    </tbody></table>
    The <span class="method_name">set_voice_type</span> method changes the voice type for the active non-mbrola voice. 
  </div>

  <div>
    <a name="set_volume"></a>
    <h3>org.gtk.gespeaker.voice.set_volume</h3>
    <p class="method_definition">bool org.gtk.gespeaker.voice.set_volume(<span class="parameter">int volume</span>)</p>
    <table class="table_parameters"><col align="left" valign="top" width="10%"><tbody>
      <tr>
        <td class="method_parameters">volume:</td>
        <td>The new volume to assign</td>
      </tr>
      <tr>
        <td class="method_parameters">Returns:</td>
        <td><span class="fixed">True</span> if the volume was assigned or <span class="fixed">False</span> if it wasn't assigned</td>
      </tr>
    </tbody></table>
    The <span class="method_name">set_volume</span> method assign the new value for volume. Valid values are between 0 and 200. 
  </div>

  <!-- footer -->
  <div>
    <br>
    <hr>
    <table width="100%">
      <tbody>
        <tr>
          <td align="left" width="40%"><a href="org.gtk.gespeaker.espeak.html">Prev</a>&nbsp;</td>
          <td align="center" width="20%"><a href="interfaces.html">Up</a></td>
          <td align="right" width="40%">&nbsp;<a href="examples.html">Next</a></td>
        </tr>
        <tr>
          <td align="left" valign="top" width="40%">/org/gtk/gespeaker/espeak&nbsp;</td>
          <td align="center" width="20%"><a href="index.html">Home</a></td>
          <td align="right" valign="top" width="40%">&nbsp;Examples</td>
        </tr>
      </tbody>
    </table>
  </div>
</body>
</html>